Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Web Docs - Stepper Component #2727

Open
wants to merge 56 commits into
base: main
Choose a base branch
from
Open

Web Docs - Stepper Component #2727

wants to merge 56 commits into from

Conversation

majedelass
Copy link
Contributor

@majedelass majedelass commented Feb 27, 2025 •
edited by dchyun
Loading

📌 Summary

If merged, this PR will add the Stepper component documentation to the website.

🛠️ Detailed description

The Stepper documentation is getting slightly restructured, where the previous Stepper Indicator will now live under a Stepper category, along side Stepper Navigation and Stepper List.

📸 Screenshots

Before
Screenshot 2025-02-27 at 11 01 24 AM

After
Screenshot 2025-03-03 at 12 03 04 PM

🔗 External links

Jira ticket: HDS-4405

💬 Please consider using conventional comments when reviewing this PR.

@majedelass majedelass requested review from a team as code owners February 27, 2025 02:26
@vercel Vercel
Copy link

vercel bot commented Feb 27, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
hds-showcase ✅ Ready (Inspect) Visit Preview Mar 24, 2025 10:15pm
hds-website ✅ Ready (Inspect) Visit Preview Mar 24, 2025 10:15pm

@hashibot-hds hashibot-hds added the docs-website Content updates to the documentation website label Feb 27, 2025
@dchyun dchyun changed the base branch from main to dchyun/stepper-component February 27, 2025 13:12
@dchyun dchyun force-pushed the dchyun/stepper-component branch from 0a8d3e2 to da2209c Compare February 27, 2025 13:14
heatherlarsen
heatherlarsen reviewed Feb 28, 2025
View reviewed changes
Copy link
Contributor

@heatherlarsen heatherlarsen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a good start. I think the separation between the two pages also helps make it more clear that these have two distinct use cases. I left quite a few suggestions and a few comments, but nothing too major.

jorytindall
jorytindall reviewed Feb 28, 2025
View reviewed changes
Copy link
Contributor

@jorytindall jorytindall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't gotten through all of this yet, but I'll take a stab at the Nav variant tomorrow.

LilithJames-HDS
LilithJames-HDS requested changes Feb 28, 2025
View reviewed changes
jorytindall
jorytindall reviewed Mar 3, 2025
View reviewed changes
Copy link
Contributor

@jorytindall jorytindall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok I got through the rest of this now, dropped some more notes and some non-blocking grammar suggestions. LMK if there's anything that needs clarification!

majedelass and others added 18 commits March 24, 2025 15:20
@majedelass @dchyun
updated path for figma component links
c23acb1
@majedelass @dchyun
updated examples for progressive disclosure
647d422
@dchyun
Fix: Address nav docs feedback
1231882
@dchyun
Feat: No panels example for nav code docs
0d1e343
@dchyun
Fix: Address nav code feedback
e0d57ed
@majedelass @dchyun @KristinLBradley
Apply suggestions from code review
974a517 
Co-authored-by: Dylan Hyun <dylan.hyun@hashicorp.com>
Co-authored-by: Kristin Bradley <kristin.bradley@hashicorp.com>
@dchyun
Feat: Update nav docs to isInteractive default of true
c9e9bb7
@dchyun
Fix: Update component api component names
5ca81cb
@majedelass @dchyun
updated images to reflect A11Y changes
004a995
@majedelass @heatherlarsen @dchyun
Apply suggestions from code review
27d888a 
Co-authored-by: Heather Larsen <hlarsen@hashicorp.com>
@majedelass @dchyun
updated images in accessibility tab
9a6d1fb
@majedelass @dchyun
updated do for list progressive disclosure.
e33acd6
@majedelass @KristinLBradley @dchyun
Apply suggestions from code review
fabca81 
Co-authored-by: Kristin Bradley <kristin.bradley@hashicorp.com>
@majedelass @KristinLBradley @dchyun
Apply suggestions from code review
b3ae399 
Co-authored-by: Kristin Bradley <kristin.bradley@hashicorp.com>
@majedelass @KristinLBradley @dchyun
Apply suggestions from code review
ebfe5cf 
Co-authored-by: Kristin Bradley <kristin.bradley@hashicorp.com>
@dchyun
Feat: Stepper::Nav add Button example
fc3bbe1
@dchyun
Fix: Remove extra Nav code example
c87c55a
@majedelass @shleewhite @dchyun
Apply suggestions from code review
da975fd 
Co-authored-by: Lee White <lee.white@hashicorp.com>
@dchyun dchyun requested review from KristinLBradley and a team March 24, 2025 19:29
@heatherlarsen
Fixing image sizes
5afffeb 
Image sizes for do/dont blocks should be 1540px. Also updating some images to use correct HDS components and guidance
heatherlarsen
heatherlarsen approved these changes Mar 24, 2025
View reviewed changes
Copy link
Contributor

@heatherlarsen heatherlarsen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dchyun I found a couple of issues with some of the screenshots so I got those updated since I don't want that to delay this from moving forward. Otherwise this looks good to go from my perspective 🙂

@dchyun dchyun requested a review from a team March 25, 2025 13:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alex-ju alex-ju alex-ju left review comments

@dchyun dchyun dchyun left review comments

@shleewhite shleewhite shleewhite approved these changes

@heatherlarsen heatherlarsen heatherlarsen approved these changes

@KristinLBradley KristinLBradley KristinLBradley approved these changes

@jorytindall jorytindall jorytindall left review comments

@LilithJames-HDS LilithJames-HDS LilithJames-HDS left review comments

Assignees
No one assigned
Labels
docs-website Content updates to the documentation website
Projects
None yet
Milestone
design-system-components@4.18.0
Development

Successfully merging this pull request may close these issues.
9 participants
@majedelass @KristinLBradley @dchyun @alex-ju @jorytindall @shleewhite @heatherlarsen @LilithJames-HDS @hashibot-hds